home *** CD-ROM | disk | FTP | other *** search
/ Java Programmer's Toolkit / Java Programmer's Toolkit.iso / editors / hexedit / he.doc < prev    next >
Encoding:
Text File  |  1994-06-08  |  20.4 KB  |  428 lines
  1.  
  2.  
  3.  
  4.  
  5.                                                                 6-07-94
  6.                                  HexEdit rev 1.3
  7.  
  8.         TABLE OF CONTENTS
  9.  
  10.         1. INTRODUCTION
  11.                 System Requirement                                      3
  12.                 File Size Restrictions                                  3
  13.                 What You Need to Know                                   3
  14.  
  15.         2. GETTING STARTED
  16.                 Backing Up HexEdit                                      3
  17.                 Installing Onto A Hard Disk                             4
  18.                 Running HexEdit                                         4
  19.  
  20.         3. FEATURES
  21.                 Getting Help                                            4
  22.                 Menus                                                   4
  23.                 Entering Bytes                                          5
  24.                 Cursor Movement                                         5
  25.                 Function Keys                                           5
  26.                         F1 - Help                                       5
  27.                         F2 - File Menu                                  5
  28.                                 Save file                               5
  29.                                 Save and name file                      5
  30.                                 Save file and exit                      5
  31.                                 Insert file                             5
  32.                                 Write block to file                     5
  33.                                 Quit, abandon edits                     5
  34.                         F3 - Edit Menu                                  5
  35.                                 Delete byte                             5
  36.                                 Delete block                            5
  37.                                 Begin block mark                        5
  38.                                 End block mark                          5
  39.                                 Clear block marks                       5
  40.                                 Copy block                              5
  41.                                 Move block                              5
  42.                                 Toggle overtype/insert mode             5
  43.                                 Toggle hex/character mode               6
  44.                                 ASCII character set window              6
  45.                         F4 - Goto Menu                                  6
  46.                                 Go to address                           6
  47.                                 Find byte string                        6
  48.                                 Previous page                           6
  49.                                 Next page                               6
  50.                                 Beginning of file                       6
  51.                                 End of file                             6
  52.                         F5 - DOS Command                                6
  53.                 Alt Keys                                                6
  54.                         Alt+a   ASCII character set window              6
  55.                         Alt+b   Begin block mark                        6
  56.                         Alt+c   Copy block                              6
  57.                         Alt+d   Delete block                            7
  58.                         Alt+e   End block mark                          7
  59.                         Alt+f   Find byte string                        7
  60.  
  61.  
  62.                                         1
  63.  
  64.  
  65.  
  66.  
  67.                         Alt+g   Go to address                           7
  68.                         Alt+h   Toggle hex/character mode               7
  69.                         Alt+i   Insert file                             7
  70.                         Alt+m   Move block                              7
  71.                         Alt+n   Save and name file                      7
  72.                         Alt+q   Quit, abandon edits                     7
  73.                         Alt+r   Clear block marks                       7
  74.                         Alt+s   Save file                               7
  75.                         Alt+w   Write block to file                     7
  76.                         Alt+x   Save file and exit                      7
  77.                 Special Keys                                            7
  78.                         BS                                              7
  79.                         Del                                             7
  80.                         End                                             7
  81.                         Enter                                           7
  82.                         Esc                                             7
  83.                         Home                                            7
  84.                         Ins                                             7
  85.                         PgDn                                            7
  86.                         PgUp                                            7
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.                                         2
  125.  
  126.  
  127.  
  128.  
  129.         INTRODUCTION
  130.  
  131.         Thank you using HexEdit.  HexEdit is an easy-to-use binary or text
  132.         file editor containing both hex byte and text editing features.
  133.         With most text editors, non-printable characters are not displayed
  134.         on the screen and editing these non-printable characters are
  135.         difficult if not impossible.  HexEdit displays all bytes within a
  136.         file(including non-printable characters) and provide powerful byte
  137.         editing features for the serious user.
  138.  
  139.         A character mode is available for quickly typing in characters rather
  140.         than editing bytes.  An ASCII character set window is also available
  141.         for viewing or entering characters from the window.
  142.  
  143.         1. System Requirements for HexEdit
  144.                 HexEdit requires an IBM XT,AT,PS1,PS2,Tandy,386,486,Pentium
  145.                 or 100% compatible with 640K RAM.
  146.  
  147.         2. File Size Restrictions
  148.                 Because the HexEdit file being edited is fully loaded into
  149.                 RAM(fast editing), file sizes are restricted by the amount
  150.                 of available RAM.  The default maximum file size is 262,144
  151.                 bytes.  Editing files larger than 262,144 is possible if
  152.                 enough conventional RAM memory is available on your system.
  153.                 Removing TSR's loaded into conventional memory will increase
  154.                 RAM.  See "3. Running HexEdit" below for more information on
  155.                 editing files larger than 262,144 bytes.
  156.  
  157.         3. What You Need to Know
  158.                 HexEdit was designed for the computer user who requires to view
  159.                 or edit bytes within a file.  I assume that you know how to
  160.                 turn on your computer and run DOS.  Review the manuals that
  161.                 came with your computer if you are unfamiliar with it.
  162.  
  163.                 Terms You Need To Know
  164.                         Default is a setting which is initially set when
  165.                         HexEdit is first used.  For example, when you run
  166.                         HexEdit, it assumes that you with start your editing
  167.                         in overtype mode and hex mode.
  168.  
  169.                         Toggle is a feature which switched the settings to the
  170.                         next possible choice.  For example, if you are in
  171.                         overtype mode and wish to change to insert mode,
  172.                         pressing the INS key will toggle the mode to insert
  173.                         mode.  Pressing INS again will toggle you back to
  174.                         overtype mode.
  175.  
  176.  
  177.         GETTING STARTED
  178.  
  179.         1. Backing Up HexEdit
  180.                 Before you begin using HexEdit, you should make a back-up copy
  181.                 of the program to another disk and on your hard disk. Back-ups
  182.                 save time and problems if something should ever happen to your
  183.                 original HexEdit program.  Refer to the DOS manual that came
  184.  
  185.  
  186.                                         3
  187.  
  188.  
  189.  
  190.  
  191.                 with your computer if you are unfamiliar with COPY or DISKCOPY.
  192.  
  193.         2. Installing Onto You Hard Disk
  194.                 HexEdit is completely contained on a single file.  Just copy
  195.                 HE.EXE into any directory within your path or make a new
  196.                 directory.  HexEdit requires no hardware set-up.
  197.  
  198.         3. Running HexEdit
  199.                 There are three different ways to run HexEdit.
  200.  
  201.                 A. Running HexEdit without a file:
  202.                         Type HE and press Enter.  A file called NO_NAME.HEX
  203.                         will be created with no bytes.  When editing is
  204.                         complete, you can press Alt+n to save and name file.
  205.  
  206.                 B. Running HexEdit with a file:
  207.                         Type HE FILENAME and press Enter.  FILENAME is the name
  208.                         of the file for editing.
  209.  
  210.                 C. Running HexEdit with a file and changing its file
  211.                    allocation size.
  212.  
  213.                         Type HE FILENAME ALLOCATION_SPACE and press Enter.
  214.                         Examples:  HE FILENAME.HEX 100000
  215.                                    HE FILENAME.HEX 350000
  216.                         FILENAME is the name of the file for editing.
  217.                         ALLOCATION_SPACE is a decimal number which specifies
  218.                         the amount of 640K RAM necessary to edit FILENAME.
  219.  
  220.                         This method of running HexEdit should be avoided unless
  221.                         memory allocation errors occur.  The default allocation
  222.                         size used to load a file into HexEdit is 262,144 bytes.
  223.                         Files larger than 262,144 bytes will require more
  224.                         allocation space.  The amount of space which cam be
  225.                         allocated is dependent on the amount of 640K RAM still
  226.                         available on your system AFTER loading HexEdit.
  227.  
  228.  
  229.         FEATURES
  230.  
  231.         1. Getting Help
  232.                 When you start HexEdit, a main menu appears with a choice for
  233.                 Help.  While in the editor, press the F1 key to display the
  234.                 help screen.
  235.  
  236.         2. Menus
  237.                 HexEdit uses pop-up menus that offer a set of choices or option
  238.                 in an organized manner.  When you first run HexEdit, you will
  239.                 drop directly into the Main Menu.  A menu option will be
  240.                 highlighted.  Press Enter to select the highlighted choice.  To
  241.                 select a different option, use the arrow keys to highlight your
  242.                 choice and press Enter or press the highlighted character.
  243.  
  244.                 While a menu is open in the editor, the left or right arrow
  245.                 keys can be used to open adjacent menus.  Press the ESC key
  246.  
  247.  
  248.                                         4
  249.  
  250.  
  251.  
  252.  
  253.                 to cancel a menu.
  254.  
  255.         3. Entering Bytes
  256.                 In the upper-right corner of the editor screen, a working area
  257.                 appears for editing the present address location.  In overtype
  258.                 mode, the byte of the present address will appear in this
  259.                 working area.  In insert mode, this working area will appear as
  260.                 dashes until data is typed in.  Once the change is completed,
  261.                 press Enter to load the change into the editor.
  262.  
  263.         4. Cursor Movement
  264.                 Cursor movement within the editor is done by moving the Arrow
  265.                 keys, HOME, END, PgUp or PgDn key.  To move the cursor to a
  266.                 specific address location, use Alt+G (Go To Address).  Alt+F
  267.                 (Find Byte String) will also move the cursor to the next
  268.                 address containing the specified byte string.
  269.  
  270.         5. Function Keys
  271.                 These five special function keys are displayed on the top
  272.                 menu of the editor screen.
  273.  
  274.                 F1 - Help
  275.                 The help screen displays all the key and key combinations.
  276.  
  277.                 F2 - File Menu
  278.                 List various choices related to file operation.
  279.  
  280.                 Save file - Saves contents of editor under the current file
  281.                         name and resumes editing.
  282.                 Save and name file - Requests a new file name, saves the
  283.                         contents of editor and resumes editing.
  284.                 Save file and exit - Saves contents of editor and returns to
  285.                         main menu.
  286.                 Insert file - Insert a file starting at the current address
  287.                         location.
  288.                 Write block to file - Requests a file name and saves bytes
  289.                         within block marks.
  290.                 Quit, abandon edits - Returns to main menu without saving
  291.                         changes to file.
  292.  
  293.                 F3 - Edit Menu
  294.                 List various choices related to editing operation.
  295.  
  296.                 Delete byte - Deletes byte in the current address location.
  297.                 Delete block - Deletes bytes located within the block marks.
  298.                 Begin block mark - Marks the current location as the beginning
  299.                         of the block.
  300.                 End block mark - Marks the current location as the end of the
  301.                         block.
  302.                 Clear block marks - Remove block marks.
  303.                 Copy block - Copies the bytes within the block marks to the
  304.                         current address location.
  305.                 Move block - Moves the bytes within the block to the current
  306.                         address location.
  307.                 Toggle overtype/insert mode - Changes the mode from which bytes
  308.  
  309.  
  310.                                         5
  311.  
  312.  
  313.  
  314.  
  315.                         are loaded into the editor.  Overtype mode (default
  316.                         mode) overwrites the contents of the byte in the
  317.                         current address location.  Insert mode will push all
  318.                         bytes equal to or greater than the current address
  319.                         location and insert the byte, block or file into the
  320.                         current address location.
  321.                 Toggle hex/character mode - Allows the user to edit characters
  322.                         instead of bytes.  Hex mode (default mode) allows the
  323.                         user to edit bytes.  Character mode allows the user to
  324.                         change bytes by typing characters.  Only printable
  325.                         ASCII characters may be used.  Printable is ASCII
  326.                         21h - 7Fh.
  327.                 ASCII character set - Use the ASCII character set window Alt+a
  328.                         for viewing or entering printable or non-printable
  329.                         characters.  Press the ESC key to remove the window.
  330.  
  331.                 F4 - Goto Menu
  332.                 List various choices related to moving the current address
  333.                 location.
  334.  
  335.                 Go to address - Move to the specified hex address location.
  336.                 Find byte string - Find the specified byte string.  Use the
  337.                         arrow keys to move to the next byte or previous bytes.
  338.                         Press Enter to begin search.  Alt+a can be used to
  339.                         enter characters.  The search begins at the present
  340.                         address location.
  341.                 Previous page - Move to the previous address screen.
  342.                 Next page - Move to the next address screen.
  343.                 Beginning of file - Go to the first address location.
  344.                 End of file - Go to the last address location.
  345.  
  346.                 F5 - DOS Command
  347.                 Allows the user to execute a DOS command.
  348.                 For example, if you want to insert a file into the editor but
  349.                 can't remember the file name, press F5.  Type DIR and press
  350.                 Enter.  Files in the current directory are displayed.  Press
  351.                 any key to return to editing.
  352.  
  353.         6. Alt Keys
  354.                 Allows the user to run task quickly rather than sifting through
  355.                 the menus on the top of the editor screen.
  356.  
  357.                 The Alt key is designed to be used in combination with another
  358.                 key to run the specified task.  For example, to use the ASCII
  359.                 character set window, hold down the Alt key and press the
  360.                 letter A.  The ASCII character set window appears on the
  361.                 screen.
  362.  
  363.                 Alt+a   ASCII character set window - Allows the user to view or
  364.                         enter an ASCII character into the editor.  Use arrow
  365.                         keys to select character within window and press Enter
  366.                         or press the ESC key to remove the window.
  367.                 Alt+b   Begin block mark - Marks the current address location
  368.                         as the beginning of the block.
  369.                 Alt+c   Copy block - Copies the bytes within the block marks to
  370.  
  371.  
  372.                                         6
  373.  
  374.  
  375.  
  376.  
  377.                         the current address location.
  378.                 Alt+d   Delete block - Deletes bytes located within the block
  379.                         marks.
  380.                 Alt+e   End block mark - Marks the current location as the end
  381.                         of the block.
  382.                 Alt+f   Find byte string - Find the specified byte string.
  383.                         Use the arrow keys to move to the next byte or previous
  384.                         bytes, then press Enter to begin search.  Alt+a can be
  385.                         used to enter characters.  The search begins at the
  386.                         present address location.
  387.                 Alt+g   Go to address - Move to the specified address.
  388.                 Alt+h   Toggle hex/character mode - Allows the user to edit
  389.                         characters instead of bytes.  Hex mode (default mode)
  390.                         allows the user to edit bytes.  Character mode allows
  391.                         the user to change bytes by typing characters.  Only
  392.                         printable ASCII characters can be used.  Printable is
  393.                         ASCII 21h - 7Fh.
  394.                 Alt+i   Insert file - Insert a file starting at the current
  395.                         address location.
  396.                 Alt+m   Move block - Moves the bytes within the block marks to
  397.                         the current address location.
  398.                 Alt+n   Save and name file - Requests a new file name, saves
  399.                         the contents of editor and resumes editing.
  400.                 Alt+q   Quit, abandon edits - Return to main menu without
  401.                         saving changes.
  402.                 Alt+r   Clear block marks - Remove block marks.
  403.                 Alt+s   Save file - Save contents of editor under current file
  404.                         name and resumes editing.
  405.                 Alt+w   Write block to file - Requests a file name and saves
  406.                         bytes within block marks.
  407.                 Alt+x   Save file and exit - Save contents of edit under
  408.                         current file name and return to main menu.
  409.  
  410.         7. Special Keys
  411.                 BS      Use backspace to delete the previous character.
  412.                 Del     Deletes the byte or character, depending on mode in
  413.                         use.
  414.                 End     Go to the last address location.
  415.                 Enter   Used to enter a byte, string or choice from a menu.
  416.                 Esc     Cancels menus or windows.
  417.                 Home    Go to the first address location.
  418.                 Ins     Changes the mode in which bytes are loaded into the
  419.                         editor.  Overtype mode (default mode) overwrites the
  420.                         contents of the byte in the current address location.
  421.                         Insert mode will push all bytes equal to or greater
  422.                         than the current address location and insert the byte,
  423.                         block or file into the current address location.
  424.                 PgDn    Move to the next address screen.
  425.                 PgUp    Move to the previous address screen.
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.                                         7
  435.  
  436.  
  437.